@types/mime-types

What is @types/mime-types?

@types/mime-types is a TypeScript type definition package for the mime-types library. The mime-types library is used to work with MIME types, which are used to specify the nature and format of a document, file, or assortment of bytes. This package provides type definitions to ensure type safety and better development experience when using the mime-types library in TypeScript projects.

What are @types/mime-types's main functionalities?

Lookup MIME Type

This feature allows you to look up the MIME type based on a file extension. In this example, the MIME type for a .txt file is retrieved.

const mime = require('mime-types');
const mimeType = mime.lookup('example.txt');
console.log(mimeType); // 'text/plain'

Lookup File Extension

This feature allows you to look up the file extension based on a MIME type. In this example, the file extension for 'text/plain' is retrieved.

const mime = require('mime-types');
const extension = mime.extension('text/plain');
console.log(extension); // 'txt'

Add Custom MIME Type

This feature allows you to define custom MIME types. In this example, a custom MIME type 'application/x-my-type' is defined for the file extension 'mytype'.

const mime = require('mime-types');
mime.define({'application/x-my-type': ['mytype']});
const mimeType = mime.lookup('file.mytype');
console.log(mimeType); // 'application/x-my-type'

Other packages similar to @types/mime-types

mime

The 'mime' package is a comprehensive MIME type utility library for Node.js. It provides similar functionalities to 'mime-types', such as looking up MIME types and extensions. However, 'mime' also includes additional features like defining custom types and loading types from files.

mime-db

The 'mime-db' package is a database of MIME types. It is used as a dependency by both 'mime' and 'mime-types' packages. While it does not provide direct utility functions, it serves as a comprehensive source of MIME type information.

file-type

The 'file-type' package is used to detect the file type of a Buffer or Uint8Array. Unlike 'mime-types', which relies on file extensions, 'file-type' inspects the actual file content to determine its type, making it more accurate in certain scenarios.

README

Installation

npm install --save @types/mime-types

Summary

This package contains type definitions for mime-types (https://github.com/jshttp/mime-types#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mime-types.

index.d.ts

export function lookup(filenameOrExt: string): string | false;
export function contentType(filenameOrExt: string): string | false;
export function extension(typeString: string): string | false;
export function charset(typeString: string): string | false;
export namespace charsets {
    const lookup: typeof charset;
}
export const types: { [key: string]: string };
export const extensions: { [key: string]: string[] };

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: none

Credits

These definitions were written by Gyusun Yeom.